ScanDocument

The ScanDocument provides a generalized interface to create laser scanning jobs. Use the ScanDocument to define the shapes and laser parameters along with the instructions on how to execute the laser marking operation. ScanDocument will process all that information to create a scanning job file that will be downloaded to the controller.

Properties

AfterCompletion Gets or sets the completion state of the marking system
BeforeStart Gets or sets the starting state of the marking state
DataType Gets the data type of the ScanDocument
DistanceUnit Get or set the units used to define marking area and lengths
Iterations Gets or sets the number of iterations to run the job
LatestVersion Gets the Version of the ScanDocument
Offset Gets or sets the offset vector to be applied to the whole
PreviewInfo Gets or sets the tracing configuration for this job
ScanDocumentName Gets the name for this ScanDocument
Scripts Gets the collection of scripts which are used in the ScanDocument
IsSaveAndUseSerailizationState Gets or Sets the serialization running parameter save and continue status
SerailizationStateSaveDataExpirationTime Gets or Sets the validity time for the saved serialization data
TransformMatrix2D Gets or Sets the 2D transformation matrix
UserName Gets or sets the user name associated with this ScanDocument

Methods

AddLaserPropertyVariable Add a variable that holds a set of laser parameters
AddScript Add a Script to control the marking
AddSerialNumberVariable Add a Serial Number variable to ScanDocument.
ClearVectorImages Clears the Vector Image list from ScanDocument.
CopyNonScanningParameters Copies all the non Scanning parameters from the given ScanDocument
CreateVectorImage Create a handler to a vector Image
EmbedFont Embed Fonts to the ScanDocument.
GetEstimatedCycleTime Estimates the cycle time in seconds for the ScanDocument.
GetVectorImages Returns the vector image list associated with this ScanDocument
PauseScanning Pauses the present laser scanning operation.
ResumeScanning Resume the present laser scanning operation after a Pause.
SendCommand Sends a priority message to the controller
SetIterations Sets the number of iterations for this laser marking.
SetLaserPropertyVariableList Adds a collection of LaserParameters to this ScanDocument.
SetScanDocumentName Set the name of this ScanDocument.
SetSerialNumberVariableList Adds a collection of Serial Number Variables to this Scandocument.
SetUserName Sets the user name associated with this ScanDocument
SetVectorImages Adds a vector image list to this ScanDocument
StartScanning Start the Laser scanning process on the associated device
StopScanning Stops the active scanning process associated with this ScanDocument.
StoreScanDocument Save the ScanDocument on the specified device

Events

CycleTimeEstimationDataReceived  
DocumentScanningStatusChanged  
ScriptCommandReceived  
ScriptCommandReceivedCom  
ScriptMessageReceived